Node / meshtastic / Meshtastic-Android / files / feature / firmware / src / commonTest / kotlin / org / meshtastic / feature / firmware / CommonMaintenanceVolumeTest.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.firmware

Tff7b72import T7ee787kotlinx.coroutines.test.runTest

Tff7b72import T7ee787org.meshtastic.core.common.util.CommonUri

Tff7b72import T7ee787org.meshtastic.core.model.DeviceHardware

Tff7b72import T7ee787org.meshtastic.core.model.SoftDeviceVariant

Tff7b72import T7ee787kotlin.test.Test

Tff7b72import T7ee787kotlin.test.assertEquals

Tff7b72import T7ee787kotlin.test.assertIs

Tff7b72import T7ee787kotlin.test.assertTrue

T8b949e/**

* Covers volume vetting and image choice — the two decisions that gate every destructive write.

*

* Abstract because it builds [CommonUri], whose Android `actual` needs Robolectric; the concrete `jvmTest` subclass

* supplies the runner. Without that subclass these tests would silently not run at all.

*/

Tff7b72abstract Tff7b72class T56d364CommonMaintenanceVolumeTest Tb4b4b4{

Tff7b72private Tff7b72val Te6edf3treeUri Tff7b72= Te6edf3CommonUriTb4b4b4.Te6edf3parseTb4b4b4(Ta5d6ff"Ta5d6ffcontent://com.android.externalstorage.documents/tree/1234-5678%3ATa5d6ff"Tb4b4b4)

Tff7b72private Tff7b72fun Td2a8ffnrfTb4b4b4(Te6edf3variantTb4b4b4: Te6edf3SoftDeviceVariant?Tb4b4b4) Tff7b72= Te6edf3DeviceHardwareTb4b4b4(

Te6edf3hwModelSlug Tff7b72= Ta5d6ff"Ta5d6ffRAK4631Ta5d6ff"Tb4b4b4,

Te6edf3platformioTarget Tff7b72= Ta5d6ff"Ta5d6ffrak4631Ta5d6ff"Tb4b4b4,

Te6edf3architecture Tff7b72= Ta5d6ff"Ta5d6ffnrf52840Ta5d6ff"Tb4b4b4,

Te6edf3softDeviceVariant Tff7b72= Te6edf3variantTb4b4b4,

Tb4b4b4)

Tff7b72private Tff7b72fun Td2a8ffrp2040Tb4b4b4(Tb4b4b4) Tff7b72= Te6edf3DeviceHardwareTb4b4b4(Te6edf3hwModelSlug Tff7b72= Ta5d6ff"Ta5d6ffRPI_PICOTa5d6ff"Tb4b4b4, Te6edf3platformioTarget Tff7b72= Ta5d6ff"Ta5d6ffpicoTa5d6ff"Tb4b4b4, Te6edf3architecture Tff7b72= Ta5d6ff"Ta5d6ffrp2040Ta5d6ff"Tb4b4b4)

Tff7b72private Tff7b72val Te6edf3rakInfo Tff7b72=

Ta5d6ff"Ta5d6ffUF2 Bootloader 0.4.3Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnModel: WisBlock RAK4631 BoardTa5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnTa5d6ff" Tff7b72+

Ta5d6ff"Ta5d6ffBoard-ID: WisBlock-RAK4631-BoardTa5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnDate: May 20 2023Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnSoftDevice: S140 6.1.1Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnTa5d6ff"

T8b949e/** RP2040 BOOTSEL volumes expose an INFO_UF2.TXT too, with no SoftDevice line. */

Tff7b72private Tff7b72val Te6edf3picoInfo Tff7b72= Ta5d6ff"Ta5d6ffUF2 Bootloader v3.0Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnModel: Raspberry Pi RP2Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnBoard-ID: RPI-RP2Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnTa5d6ff"

Tff7b72private Tff7b72class T56d364FakeVolumeTb4b4b4(Tff7b72private Tff7b72val Te6edf3removableTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72trueTb4b4b4, Tff7b72private Tff7b72val Te6edf3infoTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4) Tb4b4b4:

Te6edf3NoopFirmwareFileHandlerTb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72var Te6edf3readCount Tff7b72= T79c0ff0

Te6edf3private Tff7b72set

Tff7b72override Tff7b72suspend Tff7b72fun Td2a8ffisRemovableDestinationTb4b4b4(Te6edf3destinationUriTb4b4b4: Te6edf3CommonUriTb4b4b4)Tb4b4b4: Tffa657Boolean Tff7b72= Te6edf3removable

Tff7b72override Tff7b72suspend Tff7b72fun Td2a8ffreadSiblingTextTb4b4b4(Te6edf3treeUriTb4b4b4: Te6edf3CommonUriTb4b4b4, Te6edf3fileNameTb4b4b4: Tffa657StringTb4b4b4)Tb4b4b4: Tffa657String? Tb4b4b4{

Te6edf3readCountTff7b72+Tff7b72+

Tff7b72return Te6edf3infoTb4b4b4.Te6edf3takeIf Tb4b4b4{ Te6edf3fileNameTb4b4b4.Te6edf3equalsTb4b4b4(Te6edf3INFO_UF2_FILE_NAMETb4b4b4, Te6edf3ignoreCase Tff7b72= Tff7b72trueTb4b4b4) Tb4b4b4}

Tb4b4b4}

Tb4b4b4}

T8b949e// ── Volume vetting ───────────────────────────────────────────────────────

Tf0883e@Test

Tff7b72fun Td2a8ff`a removable volume exposing INFO_UF2 is accepted with its reported identity`Tb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

Tff7b72val Te6edf3result Tff7b72= Te6edf3inspectMaintenanceVolumeTb4b4b4(Te6edf3treeUriTb4b4b4, Te6edf3FakeVolumeTb4b4b4(Te6edf3info Tff7b72= Te6edf3rakInfoTb4b4b4)Tb4b4b4)

Tff7b72val Te6edf3accepted Tff7b72= Te6edf3assertIsTff7b72<Te6edf3VolumeInspectionTb4b4b4.Te6edf3AcceptedTff7b72>Tb4b4b4(Te6edf3resultTb4b4b4)

Te6edf3assertEqualsTb4b4b4(Ta5d6ff"Ta5d6ffWisBlock-RAK4631-BoardTa5d6ff"Tb4b4b4, Te6edf3acceptedTb4b4b4.Te6edf3volumeTb4b4b4.Te6edf3boardIdTb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4, Te6edf3acceptedTb4b4b4.Te6edf3volumeTb4b4b4.Te6edf3softDeviceTb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`an rp2040 bootsel volume is accepted with no softdevice`Tb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

Tff7b72val Te6edf3accepted Tff7b72=

Te6edf3assertIsTff7b72<Te6edf3VolumeInspectionTb4b4b4.Te6edf3AcceptedTff7b72>Tb4b4b4(Te6edf3inspectMaintenanceVolumeTb4b4b4(Te6edf3treeUriTb4b4b4, Te6edf3FakeVolumeTb4b4b4(Te6edf3info Tff7b72= Te6edf3picoInfoTb4b4b4)Tb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Ta5d6ff"Ta5d6ffRPI-RP2Ta5d6ff"Tb4b4b4, Te6edf3acceptedTb4b4b4.Te6edf3volumeTb4b4b4.Te6edf3boardIdTb4b4b4)

Te6edf3assertEqualsTb4b4b4(Tff7b72nullTb4b4b4, Te6edf3acceptedTb4b4b4.Te6edf3volumeTb4b4b4.Te6edf3softDeviceTb4b4b4, Ta5d6ff"Ta5d6ffRP2040 has no SoftDevice to reportTa5d6ff"Tb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`internal storage is rejected before INFO_UF2 is even read`Tb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

T8b949e// This is the Downloads mis-tap. Rejecting on the cheap check first means no I/O against a wrong volume.

Tff7b72val Te6edf3fake Tff7b72= Te6edf3FakeVolumeTb4b4b4(Te6edf3removable Tff7b72= Tff7b72falseTb4b4b4, Te6edf3info Tff7b72= Te6edf3rakInfoTb4b4b4)

Tff7b72val Te6edf3rejected Tff7b72= Te6edf3assertIsTff7b72<Te6edf3VolumeInspectionTb4b4b4.Te6edf3RejectedTff7b72>Tb4b4b4(Te6edf3inspectMaintenanceVolumeTb4b4b4(Te6edf3treeUriTb4b4b4, Te6edf3fakeTb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3UsbMaintenanceRefusalTb4b4b4.Te6edf3DestinationNotRemovableTb4b4b4, Te6edf3rejectedTb4b4b4.Te6edf3reasonTb4b4b4)

Te6edf3assertEqualsTb4b4b4(T79c0ff0Tb4b4b4, Te6edf3fakeTb4b4b4.Te6edf3readCountTb4b4b4, Ta5d6ff"Ta5d6ffMust not read from a volume already known to be wrongTa5d6ff"Tb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`a removable volume without INFO_UF2 is not a bootloader drive`Tb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

T8b949e// Also the CDC-only bootloader case, where no mass-storage volume exists at all.

Tff7b72val Te6edf3rejected Tff7b72= Te6edf3assertIsTff7b72<Te6edf3VolumeInspectionTb4b4b4.Te6edf3RejectedTff7b72>Tb4b4b4(Te6edf3inspectMaintenanceVolumeTb4b4b4(Te6edf3treeUriTb4b4b4, Te6edf3FakeVolumeTb4b4b4(Te6edf3info Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3UsbMaintenanceRefusalTb4b4b4.Te6edf3NotABootloaderVolumeTb4b4b4, Te6edf3rejectedTb4b4b4.Te6edf3reasonTb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`an INFO_UF2 without a board id is not a bootloader drive`Tb4b4b4(Tb4b4b4) Tff7b72= Te6edf3runTest Tb4b4b4{

Tff7b72val Te6edf3fake Tff7b72= Te6edf3FakeVolumeTb4b4b4(Te6edf3info Tff7b72= Ta5d6ff"Ta5d6ffUF2 Bootloader 0.4.3Ta5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnModel: SomethingTa5d6ff\Ta5d6ffrTa5d6ff\Ta5d6ffnTa5d6ff"Tb4b4b4)

Tff7b72val Te6edf3rejected Tff7b72= Te6edf3assertIsTff7b72<Te6edf3VolumeInspectionTb4b4b4.Te6edf3RejectedTff7b72>Tb4b4b4(Te6edf3inspectMaintenanceVolumeTb4b4b4(Te6edf3treeUriTb4b4b4, Te6edf3fakeTb4b4b4)Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3UsbMaintenanceRefusalTb4b4b4.Te6edf3NotABootloaderVolumeTb4b4b4, Te6edf3rejectedTb4b4b4.Te6edf3reasonTb4b4b4)

Tb4b4b4}

T8b949e// ── Image choice ─────────────────────────────────────────────────────────

Tf0883e@Test

Tff7b72fun Td2a8ff`erase uses the volume's softdevice when it agrees with the map`Tb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3FactoryEraseTb4b4b4,

Te6edf3nrfTb4b4b4(Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffWisBlock-RAK4631-BoardTa5d6ff"Tb4b4b4, Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Ta5d6ff"Ta5d6ffnrf_erase2.uf2Ta5d6ff"Tb4b4b4, Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3ResolvedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3assetTb4b4b4.Te6edf3fileNameTb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`erase refuses when the volume and the map disagree`Tb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3FactoryEraseTb4b4b4,

Te6edf3nrfTb4b4b4(Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffWisBlock-RAK4631-BoardTa5d6ff"Tb4b4b4, Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_7_3_0Tb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(

Te6edf3UsbMaintenanceRefusalTb4b4b4.Te6edf3SoftDeviceConflictTb4b4b4,

Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3RefusedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3reasonTb4b4b4,

Ta5d6ff"Ta5d6ffA disagreement must refuse — writing either image risks the SoftDeviceTa5d6ff"Tb4b4b4,

Tb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`erase falls back to the map when the volume reports no softdevice`Tb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3FactoryEraseTb4b4b4,

Te6edf3nrfTb4b4b4(Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_7_3_0Tb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffSomeBoardTa5d6ff"Tb4b4b4, Te6edf3softDevice Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Ta5d6ff"Ta5d6ffnrf_erase_sd7_3.uf2Ta5d6ff"Tb4b4b4, Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3ResolvedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3assetTb4b4b4.Te6edf3fileNameTb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`erase refuses when neither the volume nor the map knows the softdevice`Tb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3FactoryEraseTb4b4b4,

Te6edf3nrfTb4b4b4(Te6edf3variant Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffSomeBoardTa5d6ff"Tb4b4b4, Te6edf3softDevice Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3UsbMaintenanceRefusalTb4b4b4.Te6edf3UnknownSoftDeviceTb4b4b4, Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3RefusedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3reasonTb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`erase on rp2040 resolves without consulting a softdevice`Tb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3FactoryEraseTb4b4b4,

Te6edf3rp2040Tb4b4b4(Tb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffRPI-RP2Ta5d6ff"Tb4b4b4, Te6edf3softDevice Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Ta5d6ff"Ta5d6ffpico_erase.uf2Ta5d6ff"Tb4b4b4, Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3ResolvedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3assetTb4b4b4.Te6edf3fileNameTb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`bootloader upgrade resolves from the volume board id rather than the build target`Tb4b4b4(Tb4b4b4) Tb4b4b4{

T8b949e// Hardware reports itself as a T-Echo while the catalog target says rak4631: the volume wins, because it is the

T8b949e// thing physically in front of us.

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3BootloaderUpgradeTb4b4b4,

Te6edf3nrfTb4b4b4(Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffnRF52840-TEcho-v1Ta5d6ff"Tb4b4b4, Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertTrueTb4b4b4(Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3ResolvedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3assetTb4b4b4.Te6edf3fileNameTb4b4b4.Te6edf3containsTb4b4b4(Ta5d6ff"Ta5d6fflilygo_techoTa5d6ff"Tb4b4b4)Tb4b4b4)

Tb4b4b4}

Tf0883e@Test

Tff7b72fun Td2a8ff`bootloader upgrade refuses an unrecognized board id`Tb4b4b4(Tb4b4b4) Tb4b4b4{

Tff7b72val Te6edf3choice Tff7b72=

Te6edf3chooseMaintenanceImageTb4b4b4(

Te6edf3UsbMaintenanceRequestTb4b4b4.Te6edf3BootloaderUpgradeTb4b4b4,

Te6edf3nrfTb4b4b4(Te6edf3SoftDeviceVariantTb4b4b4.Te6edf3S140_6_1_1Tb4b4b4)Tb4b4b4,

Te6edf3MaintenanceVolumeTb4b4b4(Ta5d6ff"Ta5d6ffRPI-RP2Ta5d6ff"Tb4b4b4, Te6edf3softDevice Tff7b72= Tff7b72nullTb4b4b4)Tb4b4b4,

Tb4b4b4)

Te6edf3assertEqualsTb4b4b4(Te6edf3UsbMaintenanceRefusalTb4b4b4.Te6edf3UnknownBoardIdTb4b4b4, Te6edf3assertIsTff7b72<Te6edf3MaintenanceImageChoiceTb4b4b4.Te6edf3RefusedTff7b72>Tb4b4b4(Te6edf3choiceTb4b4b4)Tb4b4b4.Te6edf3reasonTb4b4b4)

Tb4b4b4}

Tb4b4b4}